Night Owl 9

home *** CD-ROM | disk | FTP | other *** search

/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 050a / rread201.zip / RR.DOC < prev next >

Wrap

Text File | 1993-04-13 | 48KB | 998 lines

≡ The RaLin Reader ≡ The Mammoth Text File Viewer ───────────────────────── Version 2.01 (C) Copyright 1993 Rand Nowell RaLin Enterprises ────────────────────── "Putting Bits Together" (tm) - Program Documentation - ╔═════════════════════════════════════╗ ║ THIS COPY IS AN OPEN BETA VERSION ║ ╚═════════════════════════════════════╝ ** CONTENTS ** General License..............................1 Vendors......................................1 Warranty...................................1,2 Future Versions..............................2 System Requirements..........................2 Placement of Files.........................2,3 Beta Information/Notes.......................3 Overview...................................3,4 The Tutor File, TUTOR.RR.....................4 Starting the Reader........................4,5 Mouse Support................................5 File Pick List...............................5 Display Colors.............................5,6 Line Lengths.................................6 The Reader screen..........................6,7 Dialog Boxes.................................7 Prompt Editing Keys Dialog Boxes........................7,8 Status Line...........................8 Movement Command Keys......................8,9 Other Command Keys Ctl-P: Printer Mode....................9 Ctl-F: Form Feed.......................9 Ctl-L: Line Feed.......................9 Alt-L: Print one line..................9 F8: Print Marked Text...............9 F9: Print view window...............9 F10: Print File......................9 C: Comment to File.................9 Alt-1,2,3,4: Printer Control Codes..........10 Alt-P: Toggle print to File/Prn.......10 Changing File Name..........10,11 Marking Text................................11 Word/Phrase Search Alt-C: Toggle case....................12 F: Find...........................12 N: Find Next......................12 Alt-E: Edit File............................12 Alt-N: Load New File........................13 Alt-D: DOS Shell............................13 Alt-X: Execute Command/Program..............13 Notes on Swapping...........................13 Program Configuration.......................14 New Functions...............................14 Contacting the author.......................14 Program Support.............................15 Registration................................15 Closing Remarks.............................15 Credits.....................................15 Thats it....no more! The Reader!! The RaLin Reader - Program Documentation Page 1 ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ General License Information ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Throughout this document, the term 'the reader' refers to this program, The RaLin Reader. This program is supplied as "Shareware" in the "try before you buy" concept. It is not free and is not public domain. You are free to try it for a period of ***** 20 DAYS *************, if after that period you wish to continue using it, register it. If not, please delete it from your system. If you are not familiar with the concept of 'Shareware' please see the file SHARWARE.DOC The Shareware version of this program may be freely given to others and/or sent to Bulletin Board Systems, as long as all files in this archive are included. See the README file for a list of files. This program was originally distributed in an authenticated ZIP file. I would prefer that you distribute it in the same un-altered archive. If you feel you have obtained an incomplete copy of the program, one may always be obtained from our BBS, first time callers may download, or via file request with a mailer program using the name READER. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Vendors ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Disk vendors are encouraged to include this program in your collection. We do ask that you contact us via mail or phone first. We will send the most recent shareware version along with a Vendor License. The license and your contact information will insure that you always have the most recent version of our program(s) for your clients. Please insure that your clients understand that paying your fee, does not register the program for their continued use. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Warranty - Guarantee ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Huh??? This program is released "AS IS" there IS NO guarantee other than it =WILL= take up disk space. The author will NOT be responsible for any damage to your data, system, peace of mind or anything else. By using this program, YOU assume all responsibility for its use. If you receive this or any other program developed by the author, on a magnetic medium, from the author, we =will= guarantee the quality of the medium that the program(s) are supplied on. Any defective disks will be replaced by the author, for a period of 90 days from date of purchase. As always, we try to produce bug free products, but occasionally one sneaks "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 2 in. Should this be the case, I would like to hear about it, so the problem can be corrected as soon as possible. The "FIRST" user to report a legitimate "bug" will receive a replacement copy via NetMail(only) on my dime with the fixes in place. But seriously, there should be no damage to your files. The RaLin Reader itself does not change your data in any way. If you call an editor, or any other program to act on the file the reader is currently using, and that program corrupts the file....well whose fault is that ??! ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Future Versions ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Though the plan is to continue to enhance on the concept of The RaLin Reader, and release future versions as time goes by....... The author, is not obligated to produce further versions of this program. The author also reserves the right to move =ANY= Shareware type software to the status of Commercial type software if he sees fit to do so. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ System Requirements ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The RaLin Reader should have at "least" 250K memory available in order to call an Editor and use the DOS shell. The reader uses about 110K of available memory, so its better to have at least 250K available. But when calling external programs it swaps all but about 15K out to EMS, if available, else to a temporary disk file. Screen writes are done at high speed, directly to video memory. This WILL cause "snow" on older CGA monitors. There are no switches to over-ride this. You need a newer CGA, or an EGA/VGA monitor in order to use the reader. DOS Version needs to be 3.0 or newer. Will run on a floppy, and read from floppies, though rather slowly. A hard disk is recommended. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Placement of Files ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ All executable files for The RaLin Reader should be placed in a directory that is in your DOS "PATH" statement, such as \UTIL...you do have a "UTIL" type directory don't you? <grin>..... This allows the reader to be called from anywhere on your system. If you do not do this, you will have to change to the reader's "home" directory before it can be run. Configuration files (Registered) can be handled in a couple of ways. If you wish to only have one, or one "main" one, place it in the same directory as RR.EXE (in the Path) so it can always be found on startup. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 3 You can have different config files for different projects. Simply change to the directory where you want it stored and call RRCONFIG. When the reader starts up, it checks for it's configuration file, first in the current directory, then the directories in the PATH statement. If it cannot find a config file, it uses the built in defaults. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ To Beta or Not to Beta ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Considering that The RaLin Reader is still real new, and changes and additions are always being made, you might consider it a BETA version. I do not use Beta testers per se to try out the program. "YOU" are my testers. I would rather have all types of users put the program through its paces, than a few people who are pretty PC literate. If it will survive the user who has just started using a computer, then it should survive anything. Now don't misunderstand me, I'm not saying new PC users are dumb, it's just that they don't know the "obvious" things that a seasoned user would, and so are apt to make more WRONG choices in a program, which means they will most likely be the one to find the one thing the author forgot to allow for! When you register The RaLin Reader, then you become a Registered BETA tester, and will always have the latest version to work with, and most likely any previous problems fixed. At the end of this period of development, all Registered 'Beta' users will receive a copy of the final product. At that time we will be looking for a few people to act as a Beta Team for future additions of The RaLin Reader. Currently, I expect the next 3 to 4 releases to be under Beta status, that should be enough to get all the features in that I want for now, and get them well worked over. We test here pretty thoroughly, but mistakes are still made, and things do slip by us now and then. When a problem is found, or reported, it is fixed immediately, and a new version is released, if the problem was serious enough. So all the above is something to keep in mind as you evaluate the program. If YOU find a bug, please report it right away, so we can fix it, right away. If you are a registered user, you will be sent a new copy with the fix in place, ASAP. (First user to report Bug.) ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Program Overview ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The RaLin Reader is capable of viewing a text file of ANY size. It uses an index system with a seeking procedure to seek a certain position in the text file, and display that line and the next 21 to the view window. This allows the reader to view a text file over a megabyte in size, and still not use more than about 200k of memory. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 4 The procedures used are assembler procedures, and do the seeking and writing to screen at high speed. Because the program needs to read the file, in order to set up the file index, the initial loading of the file takes more time than many other viewers, but once loaded, all other functions such as END HOME Jump to line number are much faster than most of the other viewers available. A speed test was conducted on an IBM clone XT with an 8088 processor, using a 1.2 megabyte text file. It took about 1 minute and 40 seconds to index and load the file. Now, it's true this is a longer loading time than most viewers use, but remember, NONE of the file is stored in memory, just the index, and once the file has been indexed, operations run much faster than the other viewers. I think you will find that the trade off in loading speed, is more than balanced by the handling of the loaded file. The RaLin Reader is still a new creation, and is in store for many new enhancements and additions in the future. To see what is in store for future versions refer to the WHATSUP.DOC included in this package. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ The Tutor File ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ A text file has been included to help you test some of the readers functions, it is named TUTOR.RR. Load this file into the reader with the command RR TUTOR.RR.... read the file and follow its directions, then you may want to load this manual into the reader for further reading, and maybe "Find" areas of the manual that you wish to review. NOTE: This is the same Tutor file sent with version 1.05, and has not been upgraded to cover the new features. But it will still provide some useful practice! ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Starting The RaLin Reader ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ If you have already read the tutor file, then you know how to load a file into the reader. If not, the command to view a file with The RaLin Reader is: RR <filename>....simple! The reader does NOT search the drive or path statement for the specified file. If you give it only a filename, it expects to find that file in the directory you were in when you called the reader. If the file resides in another directory, you must supply the directory and file name. If it's on another drive, specify that too. For instance, a file called MYNOTES.TXT on drive D: would be loaded like this: RR D:\MYNOTES.TXT A small opening screen will display, it will show a program header, copyright notice and display the name of the file being loaded, the size of the file, and keep a running total of the lines processed as it builds the index. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 5 Optionally you can simply enter RR at the prompt, which will present a Pick List for you to choose the file from. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Mouse Support ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Mouse Support is slowly being added to the reader. Currently it is available in the Pick Lists and Dialog Boxes with Buttons. If your mouse is active, you will see a mouse cursor when these type selections come up. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ File Pick List ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ NEW! If you call the reader with just the command RR, a picklist will be presented. You can scroll through the list, press ENTER on the file you wish to view. You may change directories by pressing ENTER on a directory name. Files in that directory will be displayed. The RaLin Reader remembers the directory you started in, and will always return you to that directory when it exits. The Pick List modifies it's size depending on how many files are present in the directory, if there are more than can be shown in the available size, you will see direction arrows to the lower right side. You can use the Up and Down arrows to move the highlight bar, PgUp and PgDn will scroll the list, pressing HOME or END will move you to the First or Last file respectively. You can also use a mouse if it is available, click once on a filename to move the bar to it, or double click (press mouse button twice rapidly) to select and load the file. You can scroll with the mouse by placing the mouse cursor on the UP or DOWN arrow and pressing the left mouse button. Whether the UP/DN arrows display or not is dependant on how many files there are to list. The Pick List also has a "HUNT" feature. Pressing a letter key will cause the highlight bar to move to the first filename found with that letter as the first character of the file name. PRessing the letter again, will move to the next file name and so on. At Startup, pressing ESCape while in the Pick List will Exit the program. See WHATSUP.DOC for planned enhancements to the Pick List. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Display Colors ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ When The RaLin Reader fires up, it searches your PATH directories for its configuration file. If found it will use those settings, if not found it will use the built in defaults. Colors are configurable with RRCONFIG.EXE the configuration program, as is the Editor name, printer controls etc. You receive RRCONFIG.EXE with the Registered Copy of The RaLin Reader. Currently the Pick List and Dialog Box colors are NOT configurable, this "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 6 will be allowed in a future version. Most likely they will inherit certain colors defined for other areas. The default colors in the evaluation copy will probably NOT be to your liking! I apologize, but it =is= an incentive to register. Other than that ALL functions in the reader are activated for your evaluation. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Line Lengths ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The RaLin Reader is designed to display files with lines of text no more than 80 characters long. If the line is longer, it will be cut off at column 80. BUT....when you print a line, the display or the file, lines will be printed in their entirety, up to 255 characters per line. This applies to output to either the printer or the Capture File (ALT-P). We have shied away from loading the file into memory, which would allow side to side scrolling for long lines, this would limit the size of the file to be loaded, to that of available memory. "Most" text files you read will be in the format of 80 characters per line. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ The Reader Screen ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Once the file has been indexed, you will be placed in view mode, with the first 22 lines of the file displayed. An example screen is shown below. ─────────────────────────────────────────────────────────────────────────── ≡The RaLin Reader 2.0≡ Top: 1 Lines: 3287 File: RR.DOC Print Mode: NORMAL ──────────────────────────────────────────────────────────────────────────── . . . 22 lines of text displayed . . . M ┌──────────────────────────────────────────────┬┼┬────┬──────┬───────┬────────┐ ├∙∙^v∙∙∙PgUp∙PgDn∙∙Home∙End∙∙J:Jump∙∙Esc:Quit∙∙│∙│ 0│Case:s│Print:p│∙F1:Help│ └──────────────────────────────────────────────┴─┴────┴──────┴───────┴────────┘ ^----Up/Dn arrow symbols. ^--- M or ∙ The above is a close representation, not all line characters show on the actual screen, used here for clarity. At the top is the information header, it contains the following: Top line upper left is the program name, followed by the Top: line number, this is the number of the line that is currently at the top of the view window. Next is the Lines: line count, the total number of lines in the text file, blank lines are counted. These line number readings can be very useful in using the JUMP function. The second line shows the name of the file being viewed, and at the far right, the print mode that will be used when sending text to the printer, "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 7 this may read NORMAL or COMPRESSED and can be toggled in the program, more on that later. At the screen bottom is the status line. It shows the movement command keys and some other information. Also the Help key and the command to Exit the reader. The Case field shows the current setting for text searching, the lower case 's' means that searching will be case INSENSITIVE, an upper case 'S' means text will be searched for "exactly" as entered. This may also be toggled in the reader. To the left of the Case box, is a field that shows the number of lines that have been marked for printing. To the left of that is a box that will display a dot, in normal mode, or if you are MARKING text, it will display a flashing upper case 'M'. Marking mode is toggled with ALT-M. The Print field show whether the printed text (displayed text) will be sent to the printer or to a file. This can also be toggled, with ALT-P. The status line is also where other messages are displayed, and where you enter values for text searching, print to file, load new file etc. Now it's time to cover all the movement keys and other functions available in the reader. If you are reading this manual in The RaLin Reader, pressing F1 will call up the Help Screen for reference. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Dialog Boxes ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ In previous versions, all messages and prompting was done on the Status line. As of Version 2.01, many messages and prompts have been converted to Dialog Boxes. If Buttons are presented in a Dialog Box, you can make your choice in one of three ways, with a mouse simply click on your choice. Or you can use the arrow keys to change the Highlighted choice, then press ENTER. And lastly, pressing the first letter of your choice will activate that choice. Until all prompts have been converted over to Dialog Boxes, there are two sets of editing keys, one for Status Line prompts, and one for Dialog Box prompts. So both sets are listed here for you. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Prompt Field Editing Keys - DIALOG BOX ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The following editing keys are active (most of them) for prompts in the Dialog Boxes. This section will be updated as needed. Some only apply if there is more than one field to fill in. CTL-W Terminate the Prompts. CTL-R Move to First Prompt Field. CTL-C Move to beginning of last prompt. CTL-V/Ins Toggle Insert mode. CTL-G/Del Delete character at cursor. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 8 CTL-T Delete word to the right of cursor. CTL-U Restore prior data to field - UNDO. CTL-Y Delete everything to the right of the cursor. CTL-S/LftArrow Move cursor left one character. CTL-D/RtArrow Move cursor right one character. CTL-E Move to beginning of previous field. CTL-X Move to beginning of next field. CTL-F Move to next word in field. CTL-A Move to prior word in field. HOME Go to first editing position of field. END Go to one position past the last character. ESC Will ABORT the prompt and re-set default(s). ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Prompt Field Editing Keys - STATUS LINE PROMPT ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The following editing keys are for the prompts that take place in the status line. At times a default value will be pre-entered for you. You have several editing keys available when you are in these prompt fields. Editing keys are - DeleteKey - Delete character at the cursor. LeftArrow - Nondestructive move cursor to the left. RightArrow - Nondestructive move cursor to the right. End - Move cursor to end of input string. Home - Move cursor to start of input string. Backspace - Delete character to the left of cursor. Ins - Toggles insert mode, cursor changes to block. Enter/Return - Accepts value(s) as entered. Esc - Aborts the entry process, also accepts the default value(s) if supplied. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Movement Command Keys ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ ArrowUp - ArrowDn Will move you one line in either direction. If you are at the top line of the file, and attempt to move upwards, an error tone will sound. If you are at the last line of the file, and attempt to move down, an error tone will sound, and an End Of File message will be displayed. NOTE: If you are on the last "page" of text via the PgDn key, pressing down arrow will allow you to scroll donwards until the last line of the file is at the top of the window. PgUp - PgDn Will move you in either direction 22 lines at a time. Attempting to Page up or down past the start or end of the file will sound an error tone. If PgDn is pressed near the end of the file, say with only 10 lines left, those 10 lines plus the preceding 12 lines will be displayed. PgDn "always" displays the last 22 lines of the file, if pressed when you are "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 9 withing the last 22 lines of the file. Attempting to PgDn past the last line of the file will sound an error tone. Home Returns you to the TOP page of the file. End Places you on the last page, last 22 lines of the file. Esc Exits the reader, closing all open files. NOTE: I hope to add mouse support to the above status line commands soon. F1 Calls the Help Screen, pressing any key will put it away. J:Jump Allows you to jump to any line in the file. You will be prompted for a line number, you will not be allowed to enter a line number less than the first line, or greater than the total number of lines in the file. When the line number prompt appears, it contains the line number of the line that is currently the "top" line. Enter the line number you wish to move to, and press enter. The line you requested will be placed at the top of the view window, followed by the next 21 lines of text. Before accepting the entry you may edit it, refer to the prior section on Editing Keys. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Other Command Keys ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ This section will cover all the other command keys, not shown on the status line. These may be referenced by pressing F1 for the Help Screen. ┌────────────────┐ │Printer Commands│ └────────────────┘ CTL-P : Toggles NORMAL/COMPRESSED print mode. CTL-F : Sends a Form Feed to the printer. CTL-L : Send a Line Feed to the printer. ALT-L : Print top line of displayed text. If the line at the top of the window is blank, nothing is done. Otherwise, that line is sent to your printer. F8 : Print text that has been previously marked with ALT-M mode. F9 : Print text displayed in view window. This will send the 22 lines of text in the view window, to the printer. F10 : Print complete file. Prints the complete file. C : Comment to File. Allows you to insert a comment in the Capture file, or print a comment line on the printer. You can also send a blank line to the output by entering one space and pressing enter. For any comment other than a blank line, it will be listed in the file, or to the printer, with the leader **COMMENT** so you can easily find them. Comments can be up to 60 characters in length. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 10 ┌────────────────┐ │Printer Control │ └────────────────┘ ALT-1,2,3,4 : These command strings or codes are set up in RRCONFIG, and may be sent to the printer by pressing the appropriate key. This allows you to set your printer to something other than COMPRESSED or NORMAL, which are built into the reader. When you press these keys, a short tone will sound, to let you know that something did indeed happen. There are no visual displays when these keys are pressed. By default, all four printer command keys are set to the code to Home the printer head. When any of the Printer commands are accessed, the reader first checks the printer status. If it is not ready and error tone will sound, and an error message will be displayed. Correct the problem, and repeat the desired command. ┌──────────────────────┐ │Print to File/Printer │ └──────────────────────┘ ALT-P : This sets up what I like to call the "Capture File". This will toggle the programs printer output. If you are in printer mode (lower case 'p') pressing ALT-P will put you in print to file mode. You will be prompted for a file name. If the file exists, you will be asked if you wish to (A)ppend output to the file, (O)verwrite the existing file, or (S)kip the whole thing. These choices are in Button selections. Refer to the previous section on Dialog Buttons for selection methods. When you are in print to file mode, an upper case 'F' will be displayed in the Print: status area. While in print to file mode, all printer output will be sent to this file. This filename remains in effect until you toggle back to printer. If you wish to change the filename you must first toggle back to printer ('p') then toggle file again ('F') then specify a new name. While in print to file mode, pressing ALT-P will toggle you back to print to printer mode. When you are prompted for a file name for the capture file, pressing ESCape will abort the process, and maintain the print to Printer mode. Changing File Name: If you wish or need to change the Capture File to be used, you first have to press Alt-P to get out of File Mode, then press it again to re-enter File Mode. Doing this will again prompt you for a file name, and the last one used will be presented as a choice. To use a new name, simply erase the old and enter the new. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 11 It is a good idea to make sure any marked text is written before changing the Capture File name. IMPORTANT! Currently the reader does NOT check for an invalid directory when prompting for a Capture File name. If you happen to enter a directory that does not exist, as part of the file name, the reader will Exit to DOS, gracefully, but nonetheless Exit. Restart RR and this time use a directory that exists! The functions that are affected by ALT-P are, F8: Print marked Text. F9: Print displayed text. C: Comment to file. ALT-L: Print top line. ┌─────────────┐ │Marking Text │ └─────────────┘ ALT-M : Alt-M is a toggle, if you are NOT in Marking Mode, you will be placed in it, and a flashing 'M' will be displayed in the Status line. If you ARE in Marking Mode, you will be put in standard mode, and a normal colored dot (∙) will be displayed in place of the 'M'. ALL MOVEMENT KEYS OTHER THAN THE UP AND DOWN ARROWS ARE DEACTIVATED WHILE YOU ARE MARKING TEXT. ALL PRINT FUNCTIONS ARE ALSO DISABLED. I will be adding Marking capability to the PgUp/PgDn keys at a later date. When you first enter marking mode, a one (1) will be displayed in the box to the right of the flashing 'M' this is incremented or decremented with each press of the up/down arrow keys. When you first enter Marking Mode, the TOP line is automatically marked. The "Marking Line" is the TOP line of the text view window, when you are ready to begin marking text, place the first line you want marked at the top of the view, make it the TOP line. Press ALT-M When you have the LAST line of text you want marked, in the TOP line position, press ALT-M again. IMPORTANT! After marking is done, it is advised that you Print/Write the marked text, by pressing F8. You will be unable to enter Marking Mode if there is marked text that has not been printed, this helps insure that you don't loose the previously marked text. Combined with the Comment feature, marking and printing/writing sections of text from the file, is a powerful tool. You can cut sections of interest out, and provide your own comments at the same time. No yellow markers, and chicken scratches all over the document page. This function is also very useful when viewing BBS file lists, you can cut filenames out to the printer or a file for later reference. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 12 ┌──────────────────┐ │Word/Phrase Search│ └──────────────────┘ ALT-C : This toggles the search case sensitivity. In the Find: box you will see either a lower case 's' or an upper case 'S'. The lower case means that the word/phrase will be found regardless of how you enter it, entering Help will find HELP, helP HeLp etc. If the upper case 'S' is shown then text will be searched for "exactly" as you enter. Using the above example, any line found containing Help would be displayed, nothing else. F: FIND....will prompt you for the text or phrase to be searched for. When the line is found, it will be displayed on line 2 of the view window, in the "found text" color. Pressing any of the movement keys, removes the Highlight color form the line of text found. N: NEXT....searches for the next occurrence of the word/phrase. Again, as the file is NOT stored in memory, the reader must check the disk file, but the search function is fairly quick. Be advised that the NON CASE SENSITIVE search 's' is somewhat slower than the CASE SENSITIVE 'S' one. ┌──────────┐ │Edit File │ └──────────┘ ALT-E : Allows you to call your favorite editor to edit the current file if you wish. The evaluation copy will only work with an editor named RE.EXE, if you wish to use this function you will have to rename your editor. The .EXE is required, so you cannot use a batch file named RE to call "your" editor. The registered version allows you to specify the editor name, along with any required switches in RRCONFIG{+}, the configuration program. NOTE: RE.EXE is a Text Editor (RaLin Editor) currently under development here. This editor =may= be included in Registered versions of the reader. If any Editor switches have been defined in RRCONFIG, they will be sent to the Editor following the File Name. Upon return from the Editor, the reader will re-build the index and load in the edited copy. As many editors do not give an exit code to tell if a file has been changed or not, and the code is different between those that do, the reader will re-scan and load the file regardless if changes have been made or not. Upon returning, you will be placed at the same screen of text you were at when you called the editor. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 13 ┌──────────────┐ │Load New File │ └──────────────┘ ALT-N : This will call the Pick List, choose the file you want and press Enter. See previous section File Pick List on how to choose the file. The reader first closes the old file, and attempts to find and load the new one. If the file cannot be found, an error tone will sound, a message will be displayed, and The RaLin Reader will Exit. Of course, this should not be a problem, if the file is in the list, then it does exist. Pressing ESC while in the Pick List for a New File, will prompt you for a choice, Reload original file or Exit. ┌─────────┐ │DOS Shell│ └─────────┘ ALT-D : Loads a second copy of COMMAND.COM and places you at the DOS prompt. A one time message will be displayed to remind you to type EXIT to return to the reader. **WARNING** Never load a TSR (Terminate and Stay Resident) type program while you are in a DOS shell from any program. This WILL corrupt memory, and generally require you to reboot the PC. You may perform any DOS commands, run other programs etc while you are in the Shell. Type EXIT to return to the reader. ┌────────────────┐ │Execute Command │ └────────────────┘ ALT-X : This will prompt you for a command or program to execute. You can run any Dos Command, a Batch File, or another program. Pressing ESCape will abort the function. NOTE: DO =NOT= CALL AN EDITOR TO EDIT THE FILE YOU ARE VIEWING WITH THIS FUNCTION. THE FILE WILL NOT BE CLOSED, AND DATA CORRUPTION WILL BE THE RESULT!!! YOU =HAVE= BEEN WARNED!! You must use ALT-E to call an editor on the file. ┌─────────────┐ │Swapping Note│ └─────────────┘ When you run another program, Shell to DOS or execute the Editor, the reader swaps all but about 15K of itself out of memory. If EMS is available, the swap file will be placed there, if not it is created in the current directory. The disk swap file is given hidden/system attribute so you cannot see it, but some programs allow these type of files to display, the file is stored as $RRSWP.$$$ ** DO NOT ERASE THIS FILE! ** , it is erased by the program on return. The reader will tell you how much swap space has been allocated, and whether it is being stored in EMS memory or to disk. "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 14 ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Program Configuration ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ RRCONFIG.EXE {+} The configuration program is a utility you receive when you register The RaLin Reader. It allows configuration of the colors used, and you can specify which editor program to call with the ALT-E command key. A DEMO version has been included. It is identical to the current RRCONFIG that is available except...it will NOT actually save the new configuration settings. In all other aspects its a working copy. Please refer to RRCONFIG.DOC for more information. NOTE: The DEMO version may not include areas for all configurable items in new versions. RRCONFIG is updated after RR, so the DEMO version may be a little behind. Your REGISTERED copy "will" be up to date! ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ New Functions ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The RaLin Reader is a new program, and new functions are being added all the time. You may, in fact, have additional functions in the registered copy you receive. See the file WHATSUP.DOC for a list of the additions planned for the reader. I hope you find The RaLin Reader to be of use to you, and I look forward to welcoming you to the RaLin Family of Users. Please see REGISTER.FRM for information on registering the reader, and what you can expect for your registration fee. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Contacting The Author ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The author can be contacted via several means. Snail Mail: Rand Nowell RaLin Enterprises 40728 Sundale Dr. Fremont, Ca. 94538 FIDO Netmail 1:161/710 Voice Phone: 510-651-0253 BBS : 510-651-0253(4 second pause)3322 Example: 510-651-0253,,3322 (for most modems) Echos FIDO - Shareware, RA_Util "If it fits on your drive, we can read it..ALL!!" The Reader!! The RaLin Reader - Program Documentation Page 15 ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Program Support ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The RaLin Reader is fully supported by the author. He can be reached via any of the above listed means for questions, suggestions etc. If no one is available, and you leave a message, Registered users will be called at our expense. Those NOT registered should be prepared to accept a collect call from the author. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Registration ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ When you register The RaLin Reader you become eligible for full support, via phone, mail, echo/net mail or BBS. You also receive the configuration program, and more. Please see the file REGISTER.FRM, it contains all information along with the Registration form itself. ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Closing Remarks ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ The RaLin Reader is on the ground floor of creation. Many new things are in store, and user input will help direct these new additions. Get in on the beginning, register now! Thanks for taking time to evaluate The RaLin Reader Rand Nowell ┌─────────────────────────────────────────────────────────────────────────────┐ │▒▒▒ Credits ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ └─────────────────────────────────────────────────────────────────────────────┘ Thanks to Borland International for some great programming software. The RaLin Reader was written with Turbo Pascal 7.0 Thanks to Trevor Carlsen for his Public Domain source, some of which was modified and used in this program. Thanks to Software Science for ToPaz and VidPop. Thanks to my wife Linda, who puts up with my long hours on the PC, without complaining......to much... and my kids, who don't always see as much of me as they should! Thanks to ALL the users who have and will Register, you are what makes Shareware work! Hey....I wanta pat 'myself' on the back too, for many of the routines used in the reader, they were not available, so I had to write them myself!! <eof RR.DOC> "If it fits on your drive, we can read it..ALL!!"